home *** CD-ROM | disk | FTP | other *** search
/ Language/OS - Multiplatform Resource Library / LANGUAGE OS.iso / cpp_libs / linklist / source.lha / doc / lFndFlagNode.3 < prev    next >
Text File  |  1993-08-08  |  1KB  |  55 lines
  1. '.so tmac.clman
  2. .TH "lFndFlagNode"
  3. .IX lFndFlagNode
  4. .SH NAME
  5. lFndFlagNode - Get node by flag.
  6. .SH SYNOPSIS
  7. int
  8. .BR "lFndFlagNode" "(id, from, flag, data, size)"
  9. .br
  10. .RT
  11. .RP
  12. In    int    id    identifier of linked list
  13. .br
  14. .RP
  15. In    int    from    from where must be searched
  16. .br
  17. .RP
  18. In    int    flag    flag of node which must be retrieved
  19. .br
  20. .RP
  21. Out    Byte    *data    data of node
  22. .br
  23. .RP
  24. In    int    size    size of data
  25. .DT
  26. .SH DESCRIPTION
  27. \fBlFndFlagNode\fP searches a 'flagged' node from the linked list. From
  28. where the node must be searched can be specified by \fIfrom\fP. A node
  29. can be searched forward from the beginning of the list or from the
  30. current node and backward from the current node or from the end of the
  31. list.
  32. .br
  33. Backward searching is only possible for doubly linked list.
  34. .br
  35. When the found node is the first or the last node, the return code will
  36. have the value lFIRST or lLAST, otherwise lFOUND.
  37. .SH PARAMETER DEFINITIONS
  38. .if t .ta 0.2i 1.5i
  39. \fIfrom\fP :
  40. .nf
  41.     lFIRST    search forward from first node
  42.     lPREVIOUS    search backward from previous node
  43.     lNEXT    search forward from next node
  44.     lLAST    search backward from last node
  45. .fi
  46. .SH RETURN CODES
  47. .nf
  48. Return on success :
  49.     lFOUND, lFIRST, lLAST, lNOT_FOUND
  50. Return on error :
  51.     lUNKNOWN_ID, lEMPTY_LIST, lWRONG_FROM, lSIZE_NE
  52. .fi
  53. .SH AUTHOR
  54. Anita Eijs (TNO - Bouw - BouwInformatica)
  55.